/*
 * Copyright (C) 2012-2017 DataStax Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.datastax.driver.osgi.api;

public interface MailboxService {

    /**
     * Retrieve all messages for a given recipient.
     *
     * @param recipient User whose mailbox is being read.
     * @return All messages in the mailbox.
     */
    public Iterable<MailboxMessage> getMessages(String recipient) throws MailboxException;

    /**
     * Stores the given message in the appropriate mailbox.
     *
     * @param message Message to send.
     * @return The timestamp generated for the message (milliseconds since the Epoch).
     */
    public long sendMessage(MailboxMessage message) throws MailboxException;

    /**
     * Deletes all mail for the given recipient.
     *
     * @param recipient User whose mailbox will be cleared.
     */
    public void clearMailbox(String recipient) throws MailboxException;
}
